api/v1/jobs/{jobno}/comments

Path: api/v1/jobs/{jobno}/comments

This API is JSON:API compliant.

This endpoint supports the following methods:
GET POST PATCH

The resource type for this endpoint is JobComment
The identifier is jobno-lineid

The JobComment resource type attributes are as follows:

{

"include":boolean

"status":string (read-only)

"comment":string

"modifyInit":string (read-only)

The modification date and time of the comment in ISO date time format. Timezone is the timezone of the Jim2 server.

"modifyDate":string (read-only)

}

Example GET (Return all)

Path: api/v1/jobs/10/comments

Response:

{
    "data": [
        {
            "id": "10-1",
            "type": "JobComment",
            "attributes": {
                "include": false,
                "status": "Booked",
                "comment": "",
                "modifyInit": "SYS",
                "modifyDate": "2024-03-25T17:07:23+11:00"
            }
        }
    ]
}

Example GET (Return specific)

Path: api/v1/jobs/10/comments/10-1

Response:

{
    "data": {
        "id": "10-1",
        "type": "JobComment",
        "attributes": {
            "include": false,
            "status": "Booked",
            "comment": "",
            "modifyInit": "SYS",
            "modifyDate": "2024-03-25T17:07:23+11:00"
        },
        "links": {
            "self": "/api/v1/jobs/10/comments/10-1"
        }
    }
}

Example POST

Path: api/v1/jobs/10/comments

Request:

{
    "data": {
        "type": "JobComment",
        "attributes": {
            "include": false,
            "comment": "Add new comment"
        }
    }
}

Response:

{
    "data": {
        "id": "10-2",
        "type": "JobComment",
      "attributes": {
        "include": false,
        "status": null,
        "comment": "Add new comment",
        "modifyInit": "API",
        "modifyDate": "2021-03-10T11:33:53"
      },
      "links": {
        "self": "/api/v1/jobs/10/comments/10-2"
      }
    }
}

Example PATCH

Path: api/v1/jobs/10/comments/10-1

Request:

{
    "data": {
        "id": "10-1",
        "type": "JobComment",
        "attributes": {
            "include": true,
            "comment": "Test"
        }
    }
}

Response:

{
    "data": {
        "id": "10-1",
        "type": "JobComment",
      "attributes": {
        "include": true,
        "status": "Booked",
        "comment": "Test",
        "modifyInit": "API",
        "modifyDate": "2021-03-10T11:33:53"
      },
        "links": {
            "self": "/api/v1/jobs/10/comments/10-1"
        }
    }
}